/*
 *  Copyright 2011 Alexey Andreev.
 * 
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 * 
 *       http://www.apache.org/licenses/LICENSE-2.0
 * 
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *  under the License.
 */
package org.xthl.wiki.api;

import java.util.List;
import org.nop.core.Remote;
import org.xthl.core.api.Requires;
import org.xthl.core.api.RestrictedAccessException;
import org.xthl.core.api.Suggests;

/**
 *
 * @author Alexey Andreev
 */
@Remote
public interface CategoryRepository {
    Category get(int categoryId);
    
    @Suggests("wiki.listDeletedCategories")
    List<Category> getChildCategories(int categoryId, boolean includeDeleted);
    
    @Suggests("wiki.listDeletedCategories")
    List<Category> getDescendants(int categoryId, boolean includeDeleted, int limit);
    
    @Requires("wiki.createCategory")
    int create(CategoryEditCommand command) throws RestrictedAccessException,
            CategoryDeletedException;
    
    @Requires("wiki.editCategory")
    void update(int categoryId, CategoryEditCommand command) throws RestrictedAccessException,
            CategoryDeletedException;
    
    @Requires("wiki.deleteCategory")
    void delete(int categoryId) throws RestrictedAccessException;
    
    @Requires("wiki.deleteCategory")
    void restore(int categoryId) throws RestrictedAccessException;
}
